<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Log Class Reference</title>
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    <meta charset="utf-8">
    <script src="../js/jquery.min.js" defer></script>
    <script src="../js/jazzy.js" defer></script>
    
    <script src="../js/lunr.min.js" defer></script>
    <script src="../js/typeahead.jquery.js" defer></script>
    <script src="../js/jazzy.search.js" defer></script>
  </head>
  <body>

    <a name="//apple_ref/swift/Class/Log" class="dashAnchor"></a>

    <a title="Log Class Reference"></a>

    <header class="header">
      <p class="header-col header-col--primary">
        <a class="header-link" href="../index.html">
          LoggerAPI 1.9.200 Docs
        </a>
         (100% documented)
      </p>
    
      <p class="header-col--secondary">
        <form role="search" action="../search.json">
          <input type="text" placeholder="Search documentation" data-typeahead>
        </form>
      </p>
    
        <p class="header-col header-col--secondary">
          <a class="header-link" href="https://github.com/Kitura/LoggerAPI/">
            <img class="header-icon" src="../img/gh.png"/>
            View on GitHub
          </a>
        </p>
    
    </header>

    <p class="breadcrumbs">
      <a class="breadcrumb" href="../index.html">LoggerAPI Reference</a>
      <img class="carat" src="../img/carat.png" />
      Log Class Reference
    </p>

    <div class="content-wrapper">
      <nav class="navigation">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/Log.html">Log</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/LoggerMessageType.html">LoggerMessageType</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/Logger.html">Logger</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">

        <section class="section">
          <div class="section-content top-matter">
            <h1>Log</h1>
              <div class="declaration">
                <div class="language">
                  
                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Log</span></code></pre>

                </div>
              </div>
            <p>A class of static members used by anyone who wants to log messages.</p>

          </div>
        </section>

        <section class="section">
          <div class="section-content">
            <div class="task-group">
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:9LoggerAPI3LogC6loggerAA0A0_pSgvpZ"></a>
                    <a name="//apple_ref/swift/Variable/logger" class="dashAnchor"></a>
                    <a class="token" href="#/s:9LoggerAPI3LogC6loggerAA0A0_pSgvpZ">logger</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>An instance of the logger. It should usually be the one and only reference
of the <code><a href="../Protocols/Logger.html">Logger</a></code> protocol implementation in the system.
This can be used in addition to <code><a href="../Classes/Log.html#/s:9LoggerAPI3LogC05swiftA07Logging0A0VSgvpZ">swiftLogger</a></code>, in which case log messages
will be sent to both loggers.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">logger</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Logger.html">Logger</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:9LoggerAPI3LogC05swiftA07Logging0A0VSgvpZ"></a>
                    <a name="//apple_ref/swift/Variable/swiftLogger" class="dashAnchor"></a>
                    <a class="token" href="#/s:9LoggerAPI3LogC05swiftA07Logging0A0VSgvpZ">swiftLogger</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>An instance of a swift-log Logger. If set, LoggerAPI will direct log messages
to swift-log. This can be used in addition to <code><a href="../Classes/Log.html#/s:9LoggerAPI3LogC6loggerAA0A0_pSgvpZ">logger</a></code>, in which case log
messages will be sent to both loggers.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">swiftLogger</span><span class="p">:</span> <span class="kt">Logging</span><span class="o">.</span><span class="kt"><a href="../Protocols/Logger.html">Logger</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:9LoggerAPI3LogC7verbose_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ"></a>
                    <a name="//apple_ref/swift/Method/verbose(_:functionName:lineNum:fileName:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:9LoggerAPI3LogC7verbose_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ">verbose(_:<wbr>functionName:<wbr>lineNum:<wbr>fileName:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Log a message for use when in verbose logging mode.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">verbose</span><span class="p">(</span><span class="n">_</span> <span class="nv">msg</span><span class="p">:</span> <span class="kd">@autoclosure</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#function</span><span class="p">,</span>
    <span class="nv">lineNum</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="kd">#line</span><span class="p">,</span> <span class="nv">fileName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#file</span> <span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>msg</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The message to be logged.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>functionName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The name of the function invoking the logger API.
                     Defaults to the name of the function invoking
                     this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>lineNum</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The line in the source code of the function invoking the
                logger API. Defaults to the line of the
                function invoking this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>fileName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The file containing the source code of the function invoking the
                 logger API. Defaults to the name of the file containing the function
                 which invokes this function.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:9LoggerAPI3LogC4info_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ"></a>
                    <a name="//apple_ref/swift/Method/info(_:functionName:lineNum:fileName:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:9LoggerAPI3LogC4info_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ">info(_:<wbr>functionName:<wbr>lineNum:<wbr>fileName:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Log an informational message.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">info</span><span class="p">(</span><span class="n">_</span> <span class="nv">msg</span><span class="p">:</span> <span class="kd">@autoclosure</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#function</span><span class="p">,</span>
    <span class="nv">lineNum</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="kd">#line</span><span class="p">,</span> <span class="nv">fileName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#file</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>msg</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The message to be logged.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>functionName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The name of the function invoking the logger API.
                     Defaults to the name of the function invoking
                     this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>lineNum</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The line in the source code of the function invoking the
                logger API. Defaults to the line of the
                function invoking this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>fileName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The file containing the source code of the function invoking the
                 logger API. Defaults to the name of the file containing the function
                 which invokes this function.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:9LoggerAPI3LogC7warning_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ"></a>
                    <a name="//apple_ref/swift/Method/warning(_:functionName:lineNum:fileName:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:9LoggerAPI3LogC7warning_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ">warning(_:<wbr>functionName:<wbr>lineNum:<wbr>fileName:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Log a warning message.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">warning</span><span class="p">(</span><span class="n">_</span> <span class="nv">msg</span><span class="p">:</span> <span class="kd">@autoclosure</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#function</span><span class="p">,</span>
    <span class="nv">lineNum</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="kd">#line</span><span class="p">,</span> <span class="nv">fileName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#file</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>msg</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The message to be logged.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>functionName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The name of the function invoking the logger API.
                     Defaults to the name of the function invoking
                     this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>lineNum</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The line in the source code of the function invoking the
                logger API. Defaults to the line of the
                function invoking this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>fileName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The file containing the source code of the function invoking the
                 logger API. Defaults to the name of the file containing the function
                 which invokes this function.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:9LoggerAPI3LogC5error_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ"></a>
                    <a name="//apple_ref/swift/Method/error(_:functionName:lineNum:fileName:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:9LoggerAPI3LogC5error_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ">error(_:<wbr>functionName:<wbr>lineNum:<wbr>fileName:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Log an error message.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">error</span><span class="p">(</span><span class="n">_</span> <span class="nv">msg</span><span class="p">:</span> <span class="kd">@autoclosure</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#function</span><span class="p">,</span>
    <span class="nv">lineNum</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="kd">#line</span><span class="p">,</span> <span class="nv">fileName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#file</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>msg</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The message to be logged.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>functionName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The name of the function invoking the logger API.
                     Defaults to the name of the function invoking
                     this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>lineNum</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The line in the source code of the function invoking the
                logger API. Defaults to the line of the
                function invoking this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>fileName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The file containing the source code of the function invoking the
                 logger API. Defaults to the name of the file containing the function
                 which invokes this function.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:9LoggerAPI3LogC5debug_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ"></a>
                    <a name="//apple_ref/swift/Method/debug(_:functionName:lineNum:fileName:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:9LoggerAPI3LogC5debug_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ">debug(_:<wbr>functionName:<wbr>lineNum:<wbr>fileName:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Log a debugging message.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">debug</span><span class="p">(</span><span class="n">_</span> <span class="nv">msg</span><span class="p">:</span> <span class="kd">@autoclosure</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#function</span><span class="p">,</span>
    <span class="nv">lineNum</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="kd">#line</span><span class="p">,</span> <span class="nv">fileName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#file</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>msg</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The message to be logged.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>functionName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The name of the function invoking the logger API.
                     Defaults to the name of the function invoking
                     this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>lineNum</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The line in the source code of the function invoking the
                logger API. Defaults to the line of the
                function invoking this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>fileName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The file containing the source code of the function invoking the
                 logger API. Defaults to the name of the file containing the function
                 which invokes this function.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:9LoggerAPI3LogC5entry_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ"></a>
                    <a name="//apple_ref/swift/Method/entry(_:functionName:lineNum:fileName:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:9LoggerAPI3LogC5entry_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ">entry(_:<wbr>functionName:<wbr>lineNum:<wbr>fileName:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Log a message when entering a function.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">entry</span><span class="p">(</span><span class="n">_</span> <span class="nv">msg</span><span class="p">:</span> <span class="kd">@autoclosure</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#function</span><span class="p">,</span>
    <span class="nv">lineNum</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="kd">#line</span><span class="p">,</span> <span class="nv">fileName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#file</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>msg</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The message to be logged.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>functionName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The name of the function invoking the logger API.
                     Defaults to the name of the function invoking
                     this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>lineNum</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The line in the source code of the function invoking the
                logger API. Defaults to the line of the
                function invoking this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>fileName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The file containing the source code of the function invoking the
                 logger API. Defaults to the name of the file containing the function
                 which invokes this function.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:9LoggerAPI3LogC4exit_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ"></a>
                    <a name="//apple_ref/swift/Method/exit(_:functionName:lineNum:fileName:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:9LoggerAPI3LogC4exit_12functionName7lineNum04fileF0ySSyXK_SSSiSStFZ">exit(_:<wbr>functionName:<wbr>lineNum:<wbr>fileName:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Log a message when exiting a function.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">exit</span><span class="p">(</span><span class="n">_</span> <span class="nv">msg</span><span class="p">:</span> <span class="kd">@autoclosure</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#function</span><span class="p">,</span>
    <span class="nv">lineNum</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="kd">#line</span><span class="p">,</span> <span class="nv">fileName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kd">#file</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>msg</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The message to be logged.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>functionName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The name of the function invoking the logger API.
                     Defaults to the name of the function invoking
                     this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>lineNum</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The line in the source code of the function invoking the
                logger API. Defaults to the line of the
                function invoking this function.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>fileName</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The file containing the source code of the function invoking the
                 logger API. Defaults to the name of the file containing the function
                 which invokes this function.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:9LoggerAPI3LogC9isLoggingySbAA0A11MessageTypeOFZ"></a>
                    <a name="//apple_ref/swift/Method/isLogging(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:9LoggerAPI3LogC9isLoggingySbAA0A11MessageTypeOFZ">isLogging(_:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Indicates if a message with a specified type (<code><a href="../Enums/LoggerMessageType.html">LoggerMessageType</a></code>) will be logged
by some configured logger (i.e. will not be filtered out). This could be a Logger
conforming to LoggerAPI, swift-log or both.</p>

<p>Note that due to differences in the log levels defined by LoggerAPI and swift-log,
their equivalence is mapped as follows:</p>
<pre class="highlight swift"><code>   <span class="kt">LoggerAPI</span><span class="p">:</span>     <span class="n">swift</span><span class="o">-</span><span class="nv">log</span><span class="p">:</span>
   <span class="o">.</span><span class="n">error</span>     <span class="o">-&gt;</span>  <span class="o">.</span><span class="n">error</span>
   <span class="o">.</span><span class="n">warning</span>   <span class="o">-&gt;</span>  <span class="o">.</span><span class="n">warning</span>
   <span class="o">.</span><span class="n">info</span>      <span class="o">-&gt;</span>  <span class="o">.</span><span class="n">notice</span>
   <span class="o">.</span><span class="n">verbose</span>   <span class="o">-&gt;</span>  <span class="o">.</span><span class="n">info</span>
   <span class="o">.</span><span class="n">debug</span>     <span class="o">-&gt;</span>  <span class="o">.</span><span class="n">debug</span>
   <span class="o">.</span><span class="n">entry</span>     <span class="o">-&gt;</span>  <span class="o">.</span><span class="n">trace</span>
   <span class="o">.</span><span class="n">exit</span>      <span class="o">-&gt;</span>  <span class="o">.</span><span class="n">trace</span>
</code></pre>

<p>For example, a swift-log Logger configured to log at the <code>.notice</code> level will log
messages from LoggerAPI at a level of <code>.info</code> or higher.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">isLogging</span><span class="p">(</span><span class="n">_</span> <span class="nv">level</span><span class="p">:</span> <span class="kt"><a href="../Enums/LoggerMessageType.html">LoggerMessageType</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>level</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The type of message (<code><a href="../Enums/LoggerMessageType.html">LoggerMessageType</a></code>).</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A Boolean indicating whether a message of the specified type
      (<code><a href="../Enums/LoggerMessageType.html">LoggerMessageType</a></code>) will be logged.</p>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </div>
        </section>

      </article>
    </div>
    <section class="footer">
      <p>&copy; 2020 <a class="link" href="https://github.com/Kitura/LoggerAPI" target="_blank" rel="external">IBM and Kitura Project Authors</a>. All rights reserved. (Last updated: 2020-11-25)</p>
      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
    </section>
  </body>
</div>
</html>
